home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 25 / Cream of the Crop 25.iso / bbs / pcsuni1.zip / PCBDE406.ZIP / PCBDE.DOC < prev    next >
Text File  |  1997-03-23  |  15KB  |  328 lines

  1. Program     :  PCBDE.PPE - Version 4.06  Compiled 03-23-97
  2.  
  3.                (c)96,1997 Practical Computer Services
  4.  
  5.  
  6.  
  7. Description :  The PCB Door Executive will replace your existing
  8.                DOOR & OPEN commands and automatically Create a menu of
  9.                all available doors & PPE's each time it is run.
  10.  
  11.                I've been running PCB for several years now and as my
  12.                BBS grows so does the number of Doors I run. I wanted
  13.                a quick way to add a door without having to go in and edit
  14.                a display file EVERY TIME! I also wanted to be able to have
  15.                my doors & PPE programs on 1 menu! Here is my solution!
  16.  
  17. Features    :  - Automatically creates Door & PPE menu when run.
  18.                - FAST, FAST, FAST!!!!
  19.                - Displays last time door was opened.
  20.                   Very handy to see what doors are actually being used!
  21.                - Displays how many times door has been opened.
  22.                - Displays 'Shortcut' commands to users.
  23.                - VERY easily maintained after initial Installation.
  24.                - Detects & loads OTHER PPE programs from the SAME menu!
  25.                - Optionally categorize doors & PPE's for easier access.
  26.                - 3 color selectable highlighting of Doors or PPE's.
  27.                - Custom Header for registered users.
  28.  
  29. Requirements:  PCBoard 15.2x
  30.                Working knowledge of PCBoard 15.2x
  31.  
  32.  
  33. Registration: $15 US funds ONLY!
  34.  
  35.               Registration removes all the nasty unregistered messages
  36.               and delays. The registration number will work for ALL future
  37.               releases of The PCB Door Executive.
  38.  
  39.               PCBDE is not free software.  PCBDE should be registered no
  40.               later than 30 days after installation.
  41.  
  42.               Refer to the enclosed file REGISTER.FRM for complete
  43.               registration instructions.
  44.  
  45.               You can call up the support BBS to generate your own key file
  46.               for this program.  Shareware is a viable concept, So give a
  47.               call to (609) 587-2672, logon,  type KEY, and
  48.               choose to register PCBDE.  Simple, quick, and kinda fun in
  49.               a BBS sort of way.  Just remember that those people who do
  50.               not pay for shareware are a slimy sort and you really don't
  51.               want to be in their company.
  52.  
  53. Support     : You can get support a number of different ways, first and
  54.               formost you can reach us directly at PCS support
  55.               bbs, (6090) 587-2672 (33.6 USR DS).  If you can not get through
  56.               due to the overwhelming urge to call at the same time as someone
  57.               else, you can reach us at our voice number (609) 584-7947 or
  58.               via Internet e-mail at bob.watson@tao.com
  59.  
  60.               Our web site is located at: http://www.nerc.com/~pcs/
  61.  
  62. Loading
  63. Other PPE's : If you would like PCBDE to load OTHER PPE's you'll need to
  64.               be sure of 2 things:
  65.  
  66.                  1) Path to PPE *MUST* be specified in PCBDE.CFG. You
  67.                     *MUST* have a trailing '\'!!!
  68.  
  69.                  2) You MUST use the same NAMING standard with the PPE
  70.                     programs as you use with the doors. for example, if
  71.                     you have a PPE called DUMMY.PPE the SHORT CUT command
  72.                     must also be DUMMY or the PPE will not load from the
  73.                     PCBoard command line. The short cut command should come
  74.                     from your CMD.LST.
  75.  
  76.  
  77.                If your path to your PPE's are to long to fit in the given
  78.                PCBDE.CFG space, then place the keyword LONG in the PATH
  79.                space.  This will tell PCBDE to pick up all path info from
  80.                the file called LONGPATH.DAT.  LONGPATH.DAT looks like so:
  81.  
  82.                            9;C:\PCB\PPE\GAMES\ADVENTURE\TEXT\
  83.                ┌───────────┘│└────────────┐
  84.  The number as shown on     │    Full path (remember no PPE name),
  85.  the doors open menu!       │    with the trailing slash!
  86.                             ┘
  87.                       A Semi-Colon
  88.  
  89.                       Simple, No?  Then the only thing you need to place in
  90.                       the PCBDE.CFG (in the slot for path) is the keyword
  91.                       LONG.  Using the LONG parameter here, will tell PCBDE
  92.                       to look in the file LONGPATH.DAT.
  93.  
  94.  
  95. From the
  96. Command Line: You can Send PCBDE 2 command line parameters!
  97.  
  98.                   'OPEN' alone will cause the user to be prompted for
  99.                          display by category or All Doors/ppe's.
  100.  
  101.                   To avoid this prompt you may type:
  102.                   OPEN A - Display All the doors/ppe's
  103.                   OPEN C - Select category
  104.  
  105.               PCBDE will pass on command line parameters to the door
  106.               being called. For example you can pass the "D" command to
  107.               Qmail with the following: "OPEN QMAIL D".
  108.  
  109.  
  110. Installation:   *********** THE IMPORTANT PART ***************
  111.  
  112.   1) Just add this PPE file name and path to your CMD.LST file
  113.      so PCBoard will run this PPE instead of the internal DOOR
  114.      command.  This is an Example of what it might look like:
  115.  
  116.         1) OPEN                0     C:\PCB\PCBDE.PPE
  117.         2) DOOR                0     C:\PCB\PCBDE.PPE
  118.  
  119.   2) Edit the PCBDE.CAT
  120.  
  121.      ********** MUST BE IN SAME DIRECTORY AS PCBDE.PPE ***************
  122.  
  123.      This is the category Control File. If you DON'T want category's
  124.      just delete this file, and your users won't be asked if they
  125.      want to see the doors by category. There is a sample PCBDE.CAT
  126.      file in the archive for you to use an example. Whatever text you
  127.      enter here is displayed to the user when they request to see a
  128.      list of category's.
  129.  
  130.      line 1  ---> Description of Category 1
  131.      line 2  ---> Description of Category 2
  132.      line 3  ---> Description of Category 3
  133.      line 4  ---> Description of Category 4
  134.      line 5  ---> Description of Category 5
  135.      line 6  ---> Description of Category 6
  136.      line 7  ---> Description of Category 7
  137.      line 8  ---> Description of Category 8
  138.      line 9  ---> Description of Category 9
  139.  
  140.      You Don't HAVE to have 9 category's! Just put in as many as you like.
  141.      If you want to add one later no problem, just add a line.
  142.  
  143.      DON'T FORGET. If you want category's, you *MUST* assign each door to a
  144.      category in the PCBDE.CFG file, or they won't be displayed properly!!!!
  145.  
  146.   3) Edit the PCBDE.COL file
  147.  
  148.      ********** MUST BE IN SAME DIRECTORY AS PCBDE.PPE ***************
  149.  
  150.      This is the Color control File. 8 lines. Each line control's
  151.      the color of a field.
  152.  
  153.      line 1  ---> Main Entry & Border
  154.      line 2  ---> Secondary Border Text
  155.      line 3  ---> Door Number
  156.      line 4  ---> Main Headings
  157.      line 5  ---> Number of Times Opened
  158.      line 6  ---> Highlighted entry #1
  159.      line 7  ---> Highlighted entry #2
  160.      line 8  ---> Highlighted entry #3
  161.      line 9  ---> Shortcut Command
  162.      line 10 ---> Last Opened
  163.  
  164.      Each line should contain 1 PCB Code. The PCBDE.COL file included
  165.      in this archive is fully commented for easy installation.
  166.  
  167.  
  168.   4) Edit the PCBDE.CFG file.
  169.  
  170.      ********** MUST BE IN SAME DIRECTORY AS PCBDE.PPE ***************
  171.  
  172.      You Can do it by hand, UGH, or use Chuck Valecek's PCBDEED3.EXE that's
  173.      included in this Archive! Thanks Chuck! PCBDEED3 makes it a snap
  174.      to change things! If you are *UPGRADING*, you'll have to add the
  175.      additional fields in by hand before using PCBDEED3.
  176.  
  177.      The layout of this file is VERY important. If you don't set this
  178.      file up correctly to begin with you'll have big problems with
  179.      PCBDE! There is an example config file in the archive, just edit
  180.      that file and replace the appropriate fields. Each line of this
  181.      file represents a door on your system. So if you have 10 doors
  182.      you should have 10 lines in your config file.
  183.  
  184.      Column 1-41  - Door Name & Description
  185.  
  186.      Column 42    - MUST BE A COMMA
  187.  
  188.      Column 43    - PATH to PPE if column 69 = '!'
  189.                     PATH *SHOULD* include trailing '\'
  190.                     PATH *SHOULD NOT* include PPE name
  191.                     LONG if this PPE path is too long to fit (see above)
  192.                     Leave *BLANK* if this is a door!
  193.  
  194.      Column 66    - MUST BE COMMA
  195.  
  196.      Column 67    - Integer 1-9
  197.                     Category Number you wish to assign this door to.
  198.  
  199.      Column 68    - MUST BE COMMA
  200.  
  201.      Column 69    - '!' Exclamation If this is a PPE.
  202.                     ' ' Blank if regular door
  203.  
  204.      Column 70    - MUST BE A COMMA
  205.  
  206.      Column 71    - '*'Asterisk if you want the door/PPE Highlighted
  207.                        with highlight Color 1.
  208.  
  209.                     '&'Asterisk if you want the door/PPE Highlighted
  210.                        with highlight Color 2.
  211.  
  212.                     '^'Asterisk if you want the door/PPE Highlighted
  213.                        with highlight Color 3.
  214.  
  215.                     ' 'Blank if you do not want this door/PPE highlighted.
  216.  
  217.      Column 72    - MUST BE A COMMA
  218.  
  219.      Column 73-80 - Shortcut command (*RIGHT JUSTIFIED*)
  220.                     due to a limitation shortcut commands
  221.                     less than 8 characters MUST be RIGHT
  222.                     justified!! See included PCBDE.CFG for example!
  223.  
  224.  
  225.   5) Create a NEW DIRECTORY BELOW the directory that you run THIS PPE
  226.      from. This Directory HAS TO BE CALLED 'DATA'.
  227.  
  228.      For example on my system I had to create the Following directory.
  229.  
  230.      ROOT──┐
  231.            ├─PCB─┬─MAIN
  232.            │     │   ┌────────────Store PCBDE PPE Here, with ALL MY PPE's
  233.            │     │         ┌───── ****New Directory just created****
  234.            │     └──PPL─┐   
  235.            │            └─DATA
  236.            └─Util
  237.  
  238.      Why do I have to create this directory you ask?
  239.      I use this directory to store information about each door/ppe.
  240.  
  241.   6) If you are a registered user and would like to use a custom header
  242.      PCBDE now supports this. Just create a file called PCBDE.HDR in the
  243.      same directory as PCBDE.PPE. Included in the release archive is an
  244.      example header file called HDR.DAT. PCBDE.PPE by default does *NOT*
  245.      use a custom header.
  246.  
  247.   7) THAT'S IT! 6 Easy steps!
  248.  
  249. Trouble
  250. Shooting    : Q) I only have 10 doors but 11 doors show up on the menu.
  251.                  The last door displayed is blank.
  252.               A) Be sure the last character on the last line of the
  253.                  PCBDE.CFG file is <ALT-26>.
  254.  
  255.               Q) Some of the lines in the display file are jumbled.
  256.               A) Please refer to the installation steps above. If the
  257.                  comma's are not placed EXACTLY on EVERY line things
  258.                  will not work right!
  259.  
  260.               Q) What's a 'SHORTCUT' command?
  261.               A) PCBoard allows you to load a door right from the main
  262.                  prompt. This feature is used by more experienced PCB
  263.                  users to avoid the menu screen.
  264.                  For normal DOOR programs the short cut command can be found
  265.                  in PCBoard's DOORS.LST file.
  266.                  For PPE's the shortcut command will be whatever you call it
  267.                  in your CMD.LST file.
  268.  
  269.               Q) PCBDE is not keeping track of how many times the door
  270.                  has been opened or the last date it was opened.
  271.               A) Be *SURE* you have created a directory called DATA under
  272.                  the directory that you run PCBDE.PPE from. Without this
  273.                  directory PCBDE can not keep track of the above 2 items.
  274.  
  275.              ┌───────────────────────────────────────────────────────────────┐
  276.              │ ┌────────────────────────────────────────────────────────────┐│
  277.              │ │  Q) The first page of the menu comes out great, but then   ││
  278.              │ │     all hell breaks loose with the display!                ││
  279.              │ │  A) This is a local ONLY problem. It's caused by the       ││
  280.              │ │     DOUBLE line display at the bottom. Use the /LOCALON    ││
  281.              │ │     switch when you log on locally and everything will     ││
  282.              │ │     look much better!                                      ││
  283.              │ │                                                            ││
  284.              │ └────────────────────────────────────────────────────────────┘│
  285.              └───────────────────────────────────────────────────────────────┘
  286.  
  287. LICENSE TO USE AGREEMENT
  288. ------------------------
  289.  
  290. Practical Computer Services grants a nonexclusive license to use PCBDE.
  291.  
  292. PCS shall have the right to terminate this license if purchaser
  293. violates any of its provisions.  Purchaser agrees that the software
  294. products and accompanying materials are the property of Practical Computer and
  295. that PCS shall maintain title to and ownership of the software products at
  296. all times.
  297.  
  298. PCS makes no warranties of any kind, expressed or implied, with
  299. respect to the quality, performance, accuracy, or fitness of PCBDE.
  300. PCS assumes no responsibility for any decisions made or actions
  301. taken on the part of the purchaser because of the use of PCBDE.  In
  302. no event shall PCS, or any of its representatives, be liable for
  303. any loss of profit or damage arising from the use or inability to use
  304. PCBDE even if Practical Computer or an authorized agent of PCS has been
  305. advised of the possibility of damage.
  306.  
  307. PCS reserves the right to make any changes, enhancements, and/or
  308. improvements to PCBDE at any time and without notice.
  309.  
  310.         (Can you beleive the crazy stuff we have to put in here?)
  311.  
  312. DISCLAIMER
  313. ----------
  314.  
  315. There is made no warranty of any kind, express or implied including
  316. without limitation, any warranties of merchantability and/or fitness
  317. for a particular purpose.  PCS shall not be liable for any
  318. damages, whether direct, indirect, special or sequential arising from
  319. a failure of this program to operate in the manner desired by the User.
  320. PCS shall not be liable for any damage to data or property
  321. which may be caused directly or indirectly by the User of this program.
  322.  
  323. IN NO EVENT WILL Practical Computer Services BE LIABLE TO YOU FOR ANY
  324. DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR
  325. CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE
  326. PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  327.  
  328.